HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

Clinical Encounter

Clinical encounter structure for Zambian health systems

Health Facility

Health facility structure for Zambian health systems

Immunization Record

Immunization record for Zambian health systems

Patient Demographics

Core patient demographic information for Zambian health systems

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

ZM-Core Adverse Event Profile

Zambia adverse event profile, including adverse events following immunization.

ZM-Core Allergy Intolerance Profile

Zambia allergy and intolerance profile for allergy substances, medicinal products, severity, and reactions.

ZM-Core Appointment Profile

Zambia appointment profile for scheduled clinical services, including SmartCare Pro appointments.

ZM-Core Care Plan Profile

Zambia care plan profile for treatment, nursing, and multidisciplinary plans.

ZM-Core Communication Audit Event Profile

Security and access audit trail for creation, routing, access, delivery, acknowledgement, or escalation of a hub communication.

ZM-Core Communication Consent Profile

An individual's consent decision governing whether and through which channels the Unified Health Communication Hub may make contact.

ZM-Core Communication Profile

The immutable delivery or receipt record produced for a communication request, including channel and delivery outcome.

ZM-Core Communication Provenance Profile

Record of who initiated or changed a communication workflow resource, when, and on whose behalf.

ZM-Core Communication Request Profile

A governed request from a Ministry health system to the Unified Health Communication Hub to route and deliver information.

ZM-Core Communication Subscription Profile

A secure R5 Subscription that activates a communication workflow when a governed communication topic matches.

ZM-Core Communication Subscription Topic Profile

A governed R5 subscription topic that describes which communication events may activate hub workflows and what may be filtered or returned.

ZM-Core Communication Task Profile

An acknowledgement, required action, recipient-resolution, or escalation task linked to a hub communication workflow.

ZM-Core Condition Profile

Zambia diagnosis/condition profile

ZM-Core Diagnostic Report Profile

Zambia diagnostic report profile for laboratory, imaging, pathology, and other diagnostic services.

ZM-Core Encounter Profile

Zambia health encounter profile

ZM-Core Facility Organization Profile

A health facility registered in the Zambia Master Facility List. Physical coordinates and site characteristics are represented by ZMCoreLocation, while offered services are represented by ZMCoreHealthcareService.

ZM-Core Healthcare Service Profile

A service directory entry used to resolve facilities, responsible teams, service coverage, and communication contacts.

ZM-Core Immunization Profile

Zambia immunization profile for vaccines administered to a patient.

ZM-Core Location Profile

A physical or administrative place from the Zambia Health Facility Registry used in facility and reporting-hierarchy routing.

ZM-Core Medication Dispense Profile

Zambia medication dispensing profile linking dispensed medicine to the prescription, patient, encounter, and dispensing facility.

ZM-Core Medication Profile

Zambia Core Medication Profile aligned to the ZAMMSA national product catalogue and the eLMIS Master Product List.

ZM-Core MedicationRequest Profile

Zambia medication request profile

ZM-Core Observation Profile

Zambia clinical observation profile

ZM-Core Organization Profile

Zambia healthcare organization profile, including identifiers and classifications used by the national Master Facility List.

ZM-Core Patient Profile

Zambia patient profile for use in health systems

ZM-Core Practitioner Profile

Zambia health workforce practitioner profile

ZM-Core Practitioner Role Profile

A current health-worker role used to route communications by responsibility rather than by hard-coded contact details.

ZM-Core Procedure Profile

Zambia procedure profile for surgical, diagnostic, therapeutic, and programme procedures.

ZM-Core Recipient Group Profile

A governed national, provincial, district, facility, patient, or workforce distribution group used for recipient resolution.

ZM-Core Related Person Profile

Zambia related person profile for next of kin, caregivers, guardians, treatment supporters, and patient-linked contacts.

ZM-Core Service Request Profile

Zambia request profile for laboratory, imaging, procedure, and referral services.

ZM-Core Specimen Profile

Zambia specimen profile for diagnostic sample collection, transport, receipt, and processing.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Approved Communication Template

Identifier of the approved message template used to render the communication.

Communication Acknowledgement Required

Whether the workflow must create and track an acknowledgement or completion Task.

Communication Data Classification

The governance classification used to determine permitted channels and payload disclosure.

Communication Expiry

The instant after which the request must not be delivered and should be completed, revoked, or escalated according to policy.

Communication Fallback Channel

An approved alternative channel to try if the preferred channel cannot deliver the message. Repetition order expresses routing order.

Communication Message Language

BCP-47 language code in which the recipient-facing message is rendered.

Communication Requesting System

The authoritative source system that submitted the communication request to the HIE.

Consent Communication Channel

A channel for which the individual's contact consent decision applies.

Medication LSI Enabled

Indicates whether this medication is enabled for the Logistics Seasonality Index (LSI).

ZM-Core Facility Registry Status

The combined operational, licensing, registration, or record-quality status assigned to a facility by the Zambia Master Facility List. This is distinct from Organization.active, which indicates whether the FHIR record is in active use.

ZM-Core Medication ATC Classification

WHO ATC classification for the product.

ZM-Core Medication Alternate Name

Alternate or brand name of the medicine, if any.

ZM-Core Medication Alternate Pack Size

Alternate pack size description, if used in Master List.

ZM-Core Medication Archived

Indicates whether the product is archived or no longer active in the catalogue.

ZM-Core Medication Can Round To Zero

Indicates whether calculated order quantities can be rounded down to zero.

ZM-Core Medication Cartons Per Pallet

Number of cartons per pallet.

ZM-Core Medication Controlled Substance

Indicates whether the product is a controlled substance.

ZM-Core Medication Description

Long description of the product from the Master List.

ZM-Core Medication Dispensing Units

Unit in which the product is dispensed (e.g. tablet, vial, bottle).

ZM-Core Medication Dosage Unit

Unit of measure for the product strength (e.g. mg, ml, IU).

ZM-Core Medication Doses Per Dispensing Unit

Number of doses per dispensing unit.

ZM-Core Medication Flammable

Indicates whether the product is flammable.

ZM-Core Medication Full Name

Full trade name of the product as it appears in the Master List.

ZM-Core Medication Full Supply

Indicates if the product is part of the full-supply list.

ZM-Core Medication Generic Name

Generic name of the medicine.

ZM-Core Medication Hazardous

Indicates whether the product is hazardous.

ZM-Core Medication Level of Access

Level of access / level of care at which this medicine is used (e.g. Health Post, Clinic, Hospital).

ZM-Core Medication Light Sensitive

Indicates whether the product is light sensitive.

ZM-Core Medication MSL Pack Size (numeric)

Numeric MSL pack size (e.g. 100, 10).

ZM-Core Medication Pack Rounding Threshold

Threshold at which pack quantities are rounded up or down.

ZM-Core Medication Pack Size (text)

Pack size description (e.g. 'Pack of 100', 'Each').

ZM-Core Medication Pack Weight

Weight of a single pack, typically in kilograms.

ZM-Core Medication Packs Per Carton

Number of packs per carton.

ZM-Core Medication Price

Unit price of the product (e.g. pack price) as a Money value.

ZM-Core Medication Product Group

Programmatic grouping (e.g. ARV, TB, Malaria, RMNCH).

ZM-Core Medication Product Type

High-level product type (e.g. Medicine, Lab Reagent, Device).

ZM-Core Medication Route of Administration

Route of administration for this medicine (e.g. oral, IM, IV).

ZM-Core Medication Shelf Life

Product shelf-life description (e.g. 24 months).

ZM-Core Medication Storage Classification

Storage classification (e.g. Room temperature, Cold chain, Freezer).

ZM-Core Medication Storage Instructions

Free-text storage instructions.

ZM-Core Medication Store Refrigerated

Indicates whether the product must be stored refrigerated.

ZM-Core Medication Store Room Temperature

Storage temperature in degrees Celsius for room temperature storage.

ZM-Core Medication Strength

Product strength as free text (e.g. '500mg', '500mg/5ml').

ZM-Core Medication Tracer

Indicates whether the product is a tracer medicine.

ZM-Core Medication Transport Instructions

Free-text transport instructions.

ZM-Core Medication WHO Approved

Indicates whether the product is WHO prequalified / approved.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ZAMMSA Medication SKU ValueSet

All ZAMMSA catalogue SKUs that are valid for use in the ZM-Core Medication profile.

ZM-Core Condition/Diagnosis

Conditions and diagnoses relevant to Zambian health

ZM-Core Encounter Type

Types of encounters in Zambian health systems

ZM-Core Marital Status

Marital status codes used in Zambian health systems

ZM-Core Observation Category

Observation categories used in Zambian health systems

ZM-Core Organization Type

Organization types used in Zambian health systems

ZM-Core Patient Gender

Patient gender codes

Zambia Communication Channel Value Set

Approved preferred and fallback delivery channels for hub communications.

Zambia Communication Consent Action Value Set

Permitted contact actions represented in a communication consent.

Zambia Communication Data Classification Value Set

Data classifications used to enforce communication disclosure rules.

Zambia Communication Lane Value Set

Communication governance lanes supported by the Zambia Unified Health Communication Hub.

Zambia Communication Task Code Value Set

Task actions supported by a communication workflow.

Zambia Master Facility List Facility Ownership Value Set

Facility ownership values permitted for a ZM-Core facility organization.

Zambia Master Facility List Facility Type Value Set

Facility types permitted for a ZM-Core facility organization.

Zambia Master Facility List Registry Status Value Set

Registry status values permitted for a ZM-Core facility organization.

Zambia Medication Level of Access

Permitted level(s) of care for use of a medicine (HP, HC, L1, L2, L3).

Zambia Product Type ValueSet

Allowed Product Type values for Medication.

Zambia eLMIS Product Group ValueSet

Allowed Product Group values from the eLMIS Master list.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

ZAMMSA Medication SKU Code System

CodeSystem representing the ZAMMSA national medicines catalogue SKUs.

Zambia Communication Channel

Delivery channels supported by the Zambia Unified Health Communication Hub.

Zambia Communication Consent Action

Consent actions governing contact by the Unified Health Communication Hub.

Zambia Communication Data Classification

Data classifications that drive disclosure and channel controls for health communications.

Zambia Communication Lane

Governance lanes used to separate communication purposes, access rules, and disclosure controls in the Zambia Unified Health Communication Hub.

Zambia Communication Task Code

Actions used to capture acknowledgement and escalation in communication workflows.

Zambia Level of Access for Medicines

Levels of care at which a medicine is allowed to be used, based on the ZAMMSA catalogue.

Zambia Master Facility List Facility Ownership

Facility ownership or controlling sector represented in the Zambia Master Facility List.

Zambia Master Facility List Facility Type

Facility types represented in the Zambia Master Facility List. Police, military, private, and NGO values are retained for source compatibility but overlap with facility ownership and should not be used when a more specific service level is known.

Zambia Master Facility List Registry Status

Combined operational, licensing, registration, and record-quality states represented by the current Zambia Master Facility List operation-status field.

Zambia Product Type (eLMIS)

Product types from the eLMIS Master Product List.

Zambia eLMIS Product Group

Short product group codes from the eLMIS Master list (e.g. ess, medsurge, equip…).

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example Communication Acknowledgement Task

Task used to capture acknowledgement and trigger escalation if the report remains outstanding.

Example Communication Consent

Example patient contact preference and permission for notifications.

Example Communication Delivery Audit Event

Example audit event showing successful delivery processing by the hub.

Example Communication Hub Subscription

Example secure REST-hook subscription for the DHIS2 reporting-reminder workflow.

Example Communication Request Provenance

Example record of the authorized actor and source system that created a communication request.

Example DHIS2 Reporting Reminder Request

Low-risk operational pilot request for a facility reporting reminder.

Example Delivered DHIS2 Reporting Reminder

Delivery record produced after the hub sends the reporting reminder.

Example ZAMMSA Betamethasone 0.1% cream/ointment

Example mapping of ZAMMSA catalogue row EM1389 into ZMCoreMedication.

Example ZM-Core Adverse Event Following Immunization

An AEFI corresponding to SmartCare Pro AdverseEvent data.

Example ZM-Core Allergy Intolerance

An allergy corresponding to a SmartCare Pro IdentifiedAllergy.

Example ZM-Core Blood Specimen

A blood specimen corresponding to SmartCare Pro identified sample collection data.

Example ZM-Core Condition

Example diagnosis of hypertension

Example ZM-Core Diagnostic Report

Example final laboratory report with a linked hemoglobin result.

Example ZM-Core Encounter

Example outpatient encounter

Example ZM-Core Encounter (JSON)

Hand-crafted JSON example of a Zambia Core Encounter.

Example ZM-Core Healthcare Service

Example facility reporting service used by the DHIS2 reminder pilot.

Example ZM-Core Hemoglobin Observation

Example laboratory result referenced by a ZM-Core DiagnosticReport.

Example ZM-Core Immunization

An administered vaccine corresponding to a SmartCare Pro ImmunizationRecord.

Example ZM-Core Laboratory Service Request

A laboratory order corresponding to a SmartCare Pro Investigation.

Example ZM-Core Location

Example physical facility location used by recipient resolution.

Example ZM-Core MedicationRequest

Example medication prescription

Example ZM-Core Observation - Blood Pressure

Example blood pressure reading

Example ZM-Core Organization

Example Master Facility List health facility in Zambia

Example ZM-Core Organization (JSON)

Hand-crafted JSON example of a Zambia Core Organization.

Example ZM-Core Patient

Example patient from Lusaka, Zambia

Example ZM-Core Patient (JSON)

Hand-crafted JSON example of a Zambia Core Patient.

Example ZM-Core Practitioner (from HRMS)

Example practitioner mapped from HRMS/Odoo hr.employee + qualifications.

Example ZM-Core Practitioner Role

Example current District Health Information Officer role resolved from the provider directory.

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

Active Communication Request Topic

R5 SubscriptionTopic for communication requests that are ready for processing by the hub.